<!DOCTYPE html>
<html lang="en-US">
<head>
    <meta charset="UTF-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="language" content="en" />
        <link href="./assets/ffd55088/css/bootstrap.css" rel="stylesheet">
<link href="./assets/5cf9384a/solarized_light.css" rel="stylesheet">
<link href="./assets/6c54116e/style.css" rel="stylesheet">
<script src="./assets/a44cef0f/jquery.js"></script>
<script src="./assets/ffd55088/js/bootstrap.js"></script>
<script src="./assets/8ac4e28a/jssearch.js"></script>    <title>Yii Framework 2.0 API Documentation</title>
</head>
<body>

<div class="wrap">
    <nav id="w13608" class="navbar-inverse navbar-fixed-top navbar" role="navigation"><div class="navbar-header"><button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#w13608-collapse"><span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span></button><a class="navbar-brand" href="./index.html">Yii Framework 2.0 API Documentation</a></div><div id="w13608-collapse" class="collapse navbar-collapse"><ul id="w13609" class="navbar-nav nav"><li><a href="./index.html">Class reference</a></li>
<li class="dropdown"><a class="dropdown-toggle" href="#" data-toggle="dropdown">Extensions <b class="caret"></b></a><ul id="w13610" class="dropdown-menu"><li><a href="./ext-apidoc-index.html" tabindex="-1">apidoc</a></li>
<li><a href="./ext-authclient-index.html" tabindex="-1">authclient</a></li>
<li><a href="./ext-bootstrap-index.html" tabindex="-1">bootstrap</a></li>
<li><a href="./ext-codeception-index.html" tabindex="-1">codeception</a></li>
<li><a href="./ext-debug-index.html" tabindex="-1">debug</a></li>
<li><a href="./ext-elasticsearch-index.html" tabindex="-1">elasticsearch</a></li>
<li><a href="./ext-faker-index.html" tabindex="-1">faker</a></li>
<li><a href="./ext-gii-index.html" tabindex="-1">gii</a></li>
<li><a href="./ext-imagine-index.html" tabindex="-1">imagine</a></li>
<li><a href="./ext-jui-index.html" tabindex="-1">jui</a></li>
<li><a href="./ext-mongodb-index.html" tabindex="-1">mongodb</a></li>
<li><a href="./ext-redis-index.html" tabindex="-1">redis</a></li>
<li><a href="./ext-smarty-index.html" tabindex="-1">smarty</a></li>
<li><a href="./ext-sphinx-index.html" tabindex="-1">sphinx</a></li>
<li><a href="./ext-swiftmailer-index.html" tabindex="-1">swiftmailer</a></li>
<li><a href="./ext-twig-index.html" tabindex="-1">twig</a></li></ul></li>
<li><a href="./guide-README.html">Guide</a></li></ul><div class="navbar-form navbar-left" role="search">
  <div class="form-group">
    <input id="searchbox" type="text" class="form-control" placeholder="Search">
  </div>
</div>
</div></nav>
    <div id="search-resultbox" style="display: none;" class="modal-content">
        <ul id="search-results">
        </ul>
    </div>

    
<div class="row">
    <div class="col-md-3">
                <div id="navigation" class="list-group"><a class="list-group-item" href="#navigation-13607" data-toggle="collapse" data-parent="#navigation">yii\bootstrap <b class="caret"></b></a><div id="navigation-13607" class="submenu panel-collapse collapse in"><a class="list-group-item" href="./yii-bootstrap-activefield.html">ActiveField</a>
<a class="list-group-item" href="./yii-bootstrap-activeform.html">ActiveForm</a>
<a class="list-group-item" href="./yii-bootstrap-alert.html">Alert</a>
<a class="list-group-item" href="./yii-bootstrap-basehtml.html">BaseHtml</a>
<a class="list-group-item" href="./yii-bootstrap-bootstrapasset.html">BootstrapAsset</a>
<a class="list-group-item" href="./yii-bootstrap-bootstrappluginasset.html">BootstrapPluginAsset</a>
<a class="list-group-item" href="./yii-bootstrap-bootstrapthemeasset.html">BootstrapThemeAsset</a>
<a class="list-group-item" href="./yii-bootstrap-bootstrapwidgettrait.html">BootstrapWidgetTrait</a>
<a class="list-group-item" href="./yii-bootstrap-button.html">Button</a>
<a class="list-group-item" href="./yii-bootstrap-buttondropdown.html">ButtonDropdown</a>
<a class="list-group-item" href="./yii-bootstrap-buttongroup.html">ButtonGroup</a>
<a class="list-group-item" href="./yii-bootstrap-carousel.html">Carousel</a>
<a class="list-group-item" href="./yii-bootstrap-collapse.html">Collapse</a>
<a class="list-group-item" href="./yii-bootstrap-dropdown.html">Dropdown</a>
<a class="list-group-item" href="./yii-bootstrap-html.html">Html</a>
<a class="list-group-item" href="./yii-bootstrap-inputwidget.html">InputWidget</a>
<a class="list-group-item" href="./yii-bootstrap-modal.html">Modal</a>
<a class="list-group-item" href="./yii-bootstrap-nav.html">Nav</a>
<a class="list-group-item" href="./yii-bootstrap-navbar.html">NavBar</a>
<a class="list-group-item" href="./yii-bootstrap-progress.html">Progress</a>
<a class="list-group-item" href="./yii-bootstrap-tabs.html">Tabs</a>
<a class="list-group-item" href="./yii-bootstrap-togglebuttongroup.html">ToggleButtonGroup</a>
<a class="list-group-item" href="./yii-bootstrap-widget.html">Widget</a></div></div>    </div>
    <div class="col-md-9 api-content" role="main">
        <h1>Twitter Bootstrap Extension for Yii 2 <span id="twitter-bootstrap-extension-for-yii-2"></span><a href="#twitter-bootstrap-extension-for-yii-2" class="hashlink">&para;</a></h1>
<div class="toc"><ol><li><a href="#installation">Installation</a></li>
<li><a href="#usage">Usage</a></li></ol></div>
<p>This is the Twitter Bootstrap extension for <a href="http://www.yiiframework.com">Yii framework 2.0</a>. It encapsulates <a href="http://getbootstrap.com/">Bootstrap</a> components
and plugins in terms of Yii widgets, and thus makes using Bootstrap components/plugins
in Yii applications extremely easy.</p>
<p>For license information check the <a href="LICENSE.md">LICENSE</a>-file.</p>
<p>Documentation is at <a href="docs/guide/README.md">docs/guide/README.md</a>.</p>
<p><a href="https://packagist.org/packages/yiisoft/yii2-bootstrap"><img src="https://poser.pugx.org/yiisoft/yii2-bootstrap/v/stable.png" alt="Latest Stable Version" /></a>
<a href="https://packagist.org/packages/yiisoft/yii2-bootstrap"><img src="https://poser.pugx.org/yiisoft/yii2-bootstrap/downloads.png" alt="Total Downloads" /></a>
<a href="https://travis-ci.org/yiisoft/yii2-bootstrap"><img src="https://travis-ci.org/yiisoft/yii2-bootstrap.svg?branch=master" alt="Build Status" /></a></p>
<h2>Installation <span id="installation"></span><a href="#installation" class="hashlink">&para;</a></h2><p>The preferred way to install this extension is through <a href="http://getcomposer.org/download/">composer</a>.</p>
<p>Either run</p>
<pre><code class="hljs nginx"><span class="hljs-title">php</span> composer.phar require --prefer-dist yiisoft/yii2-bootstrap
</code></pre>
<p>or add</p>
<pre><code class="hljs bash"><span class="hljs-string">"yiisoft/yii2-bootstrap"</span>: <span class="hljs-string">"~2.0.0"</span>
</code></pre>
<p>to the require section of your <code>composer.json</code> file.</p>
<h2>Usage <span id="usage"></span><a href="#usage" class="hashlink">&para;</a></h2><p>For example, the following
single line of code in a view file would render a Bootstrap Progress plugin:</p>
<pre><code class="hljs php language-php"><span class="hljs-preprocessor">&lt;?</span>= yii\bootstrap\Progress::widget([<span class="hljs-string">'percent'</span> =&gt; <span class="hljs-number">60</span>, <span class="hljs-string">'label'</span> =&gt; <span class="hljs-string">'test'</span>]) <span class="hljs-preprocessor">?&gt;</span>
</code></pre>
<h1>Class Reference</h1>

<table class="summaryTable docIndex table table-bordered table-striped table-hover">
    <colgroup>
        <col class="col-package" />
        <col class="col-class" />
        <col class="col-description" />
    </colgroup>
    <tr>
        <th>Class</th>
        <th>Description</th>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-activefield.html">yii\bootstrap\ActiveField</a></td>
        <td>A Bootstrap 3 enhanced version of <a href="yii-widgets-activefield.html">yii\widgets\ActiveField</a>.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-activeform.html">yii\bootstrap\ActiveForm</a></td>
        <td>A Bootstrap 3 enhanced version of <a href="yii-widgets-activeform.html">yii\widgets\ActiveForm</a>.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-alert.html">yii\bootstrap\Alert</a></td>
        <td>Alert renders an alert bootstrap component.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-basehtml.html">yii\bootstrap\BaseHtml</a></td>
        <td>BaseHtml provides concrete implementation for <a href="yii-bootstrap-html.html">yii\bootstrap\Html</a>.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-bootstrapasset.html">yii\bootstrap\BootstrapAsset</a></td>
        <td>Asset bundle for the Twitter bootstrap css files.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-bootstrappluginasset.html">yii\bootstrap\BootstrapPluginAsset</a></td>
        <td>Asset bundle for the Twitter bootstrap javascript files.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-bootstrapthemeasset.html">yii\bootstrap\BootstrapThemeAsset</a></td>
        <td>Asset bundle for the Twitter bootstrap default theme.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-bootstrapwidgettrait.html">yii\bootstrap\BootstrapWidgetTrait</a></td>
        <td>BootstrapWidgetTrait is the trait, which provides basic for all bootstrap widgets features.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-button.html">yii\bootstrap\Button</a></td>
        <td>Button renders a bootstrap button.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-buttondropdown.html">yii\bootstrap\ButtonDropdown</a></td>
        <td>ButtonDropdown renders a group or split button dropdown bootstrap component.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-buttongroup.html">yii\bootstrap\ButtonGroup</a></td>
        <td>ButtonGroup renders a button group bootstrap component.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-carousel.html">yii\bootstrap\Carousel</a></td>
        <td>Carousel renders a carousel bootstrap javascript component.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-collapse.html">yii\bootstrap\Collapse</a></td>
        <td>Collapse renders an accordion bootstrap javascript component.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-dropdown.html">yii\bootstrap\Dropdown</a></td>
        <td>Dropdown renders a Bootstrap dropdown menu component.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-html.html">yii\bootstrap\Html</a></td>
        <td>Html is an enhanced version of <a href="yii-helpers-html.html">yii\helpers\Html</a> helper class dedicated to the Bootstrap needs.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-inputwidget.html">yii\bootstrap\InputWidget</a></td>
        <td>InputWidget is an adjusted for bootstrap needs version of <a href="yii-widgets-inputwidget.html">yii\widgets\InputWidget</a>.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-modal.html">yii\bootstrap\Modal</a></td>
        <td>Modal renders a modal window that can be toggled by clicking on a button.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-nav.html">yii\bootstrap\Nav</a></td>
        <td>Nav renders a nav HTML component.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-navbar.html">yii\bootstrap\NavBar</a></td>
        <td>NavBar renders a navbar HTML component.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-progress.html">yii\bootstrap\Progress</a></td>
        <td>Progress renders a bootstrap progress bar component.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-tabs.html">yii\bootstrap\Tabs</a></td>
        <td>Tabs renders a Tab bootstrap javascript component.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-togglebuttongroup.html">yii\bootstrap\ToggleButtonGroup</a></td>
        <td>ToggleButtonGroup allows rendering form inputs Checkbox/Radio toggle button groups.</td>
    </tr>
    <tr>
        <td><a href="yii-bootstrap-widget.html">yii\bootstrap\Widget</a></td>
        <td>\yii\bootstrap\Widget is the base class for all bootstrap widgets.</td>
    </tr>
</table>
    </div>
</div>

<script type="text/javascript">
    /*<![CDATA[*/
    $("a.toggle").on('click', function () {
        var $this = $(this);
        if ($this.hasClass('properties-hidden')) {
            $this.text($this.text().replace(/Show/,'Hide'));
            $this.parents(".summary").find(".inherited").show();
            $this.removeClass('properties-hidden');
        } else {
            $this.text($this.text().replace(/Hide/,'Show'));
            $this.parents(".summary").find(".inherited").hide();
            $this.addClass('properties-hidden');
        }

        return false;
    });
    /*
     $(".sourceCode a.show").toggle(function () {
     $(this).text($(this).text().replace(/show/,'hide'));
     $(this).parents(".sourceCode").find("div.code").show();
     },function () {
     $(this).text($(this).text().replace(/hide/,'show'));
     $(this).parents(".sourceCode").find("div.code").hide();
     });
     $("a.sourceLink").click(function () {
     $(this).attr('target','_blank');
     });
     */
    /*]]>*/
</script>


</div>

<footer class="footer">
        <p class="pull-right"><small>Page generated on Sat, 09 Jul 2016 12:16:03 +0000</small></p>
    Powered by <a href="http://www.yiiframework.com/" rel="external">Yii Framework</a></footer>

<script type="text/javascript">jQuery(document).ready(function () {
    var shiftWindow = function () { scrollBy(0, -50) };
    if (location.hash) setTimeout(shiftWindow, 1);
    window.addEventListener("hashchange", shiftWindow);
var element = document.createElement("script");
element.src = "./jssearch.index.js";
document.body.appendChild(element);

var searchBox = $('#searchbox');

// search when typing in search field
searchBox.on("keyup", function(event) {
    var query = $(this).val();

    if (query == '' || event.which == 27) {
        $('#search-resultbox').hide();
        return;
    } else if (event.which == 13) {
        var selectedLink = $('#search-resultbox a.selected');
        if (selectedLink.length != 0) {
            document.location = selectedLink.attr('href');
            return;
        }
    } else if (event.which == 38 || event.which == 40) {
        $('#search-resultbox').show();

        var selected = $('#search-resultbox a.selected');
        if (selected.length == 0) {
            $('#search-results').find('a').first().addClass('selected');
        } else {
            var next;
            if (event.which == 40) {
                next = selected.parent().next().find('a').first();
            } else {
                next = selected.parent().prev().find('a').first();
            }
            if (next.length != 0) {
                var resultbox = $('#search-results');
                var position = next.position();

//              TODO scrolling is buggy and jumps around
//                resultbox.scrollTop(Math.floor(position.top));
//                console.log(position.top);

                selected.removeClass('selected');
                next.addClass('selected');
            }
        }

        return;
    }
    $('#search-resultbox').show();
    $('#search-results').html('<li><span class="no-results">No results</span></li>');

    var result = jssearch.search(query);

    if (result.length > 0) {
        var i = 0;
        var resHtml = '';

        for (var key in result) {
            if (i++ > 20) {
                break;
            }
            resHtml = resHtml +
            '<li><a href="' + result[key].file.u.substr(3) +'"><span class="title">' + result[key].file.t + '</span>' +
            '<span class="description">' + result[key].file.d + '</span></a></li>';
        }
        $('#search-results').html(resHtml);
    }
});

// hide the search results on ESC
$(document).on("keyup", function(event) { if (event.which == 27) { $('#search-resultbox').hide(); } });
// hide search results on click to document
$(document).bind('click', function (e) { $('#search-resultbox').hide(); });
// except the following:
searchBox.bind('click', function(e) { e.stopPropagation(); });
$('#search-resultbox').bind('click', function(e) { e.stopPropagation(); });

});</script></body>
</html>
